home *** CD-ROM | disk | FTP | other *** search
/ Best Tools for JAVA / Best Tools for JAVA.iso / JAVA_ALL / IDE / SUBARTIC / SUB_ARCT / CONSTRAI / VALUE_CO.JAV < prev    next >
Encoding:
Text File  |  1996-10-04  |  2.9 KB  |  66 lines
  1.  
  2. package sub_arctic.constraints;
  3.  
  4.  
  5. /** 
  6.  * An interface for objects that receive (consume) values within the 
  7.  * "external value" system.  This system bridges the lightweight constraint 
  8.  * system to external entities -- either to non-local dependents, to 
  9.  * heavyweight constraints, or to "application" objects.  Value_consumer 
  10.  * objects may maintain several parts (each with a unique integer designator).
  11.  * Each of these parts may be dependent on (or interested in) one or more
  12.  * parts of various value_provider objects.  Value_consumer objects register
  13.  * themselves with value_value_provider objects using the attach_dependent()
  14.  * method.  Subsequently, they relieve value_ood() messages whenever the
  15.  * value in question changes (or might have changed).  At an appropriate 
  16.  * point, the consumer object may then use the get_value() method to retrieve
  17.  * an updated value.
  18.  *
  19.  * @author Scott Hudson
  20.  */
  21. public interface value_consumer {
  22.   /** 
  23.    * Indicate that a value (a part of a value_provider object) has, or might 
  24.    * have, changed value.  This object can use the get_value() method to
  25.    * retrieve the updated value.  However, this method should not immediately
  26.    * request that value.  Instead it must wait until all marking is complete.
  27.    * Inside the constraint system this is handled by waiting for the value to
  28.    * be demanded.  In other circumstances this may require a request for 
  29.    * evaluation to be queued elsewhere.<p>
  30.    * 
  31.    * @param int            for_part_here the part number within this object 
  32.    *                                     being informed that it may be out of
  33.    *                                     date.
  34.    * @param value_provider prov_obj      the object providing the value that 
  35.    *                                     may have changed.
  36.    * @param int            prov_part     the part number within that object 
  37.    *                                     which have changed value.
  38.    */
  39.    public void value_ood(
  40.      int            for_part_here, 
  41.      value_provider prov_obj, 
  42.      int            prov_part);
  43.  
  44.    //had:
  45.    //* @exception bad_value if the object is null or one of the parts is not a
  46.    //*                      valid part number for the object it is associated 
  47.    //*                      with.
  48.    //* @exception general
  49. }
  50. /*=========================== COPYRIGHT NOTICE ===========================
  51.  
  52. This file is part of the subArctic user interface toolkit.
  53.  
  54. Copyright (c) 1996 Scott Hudson and Ian Smith
  55. All rights reserved.
  56.  
  57. The subArctic system is freely available for most uses under the terms
  58. and conditions described in 
  59.   http://www.cc.gatech.edu/gvu/ui/sub_arctic/sub_arctic/doc/usage.html 
  60. and appearing in full in the lib/interactor.java source file.
  61.  
  62. The current release and additional information about this software can be 
  63. found starting at: http://www.cc.gatech.edu/gvu/ui/sub_arctic/
  64.  
  65. ========================================================================*/
  66.